Skip to content

gh-148488: Clarify py -V documentation examples#153308

Open
zainnadeem786 wants to merge 1 commit into
python:mainfrom
zainnadeem786:docs/clarify-py-v-slashes
Open

gh-148488: Clarify py -V documentation examples#153308
zainnadeem786 wants to merge 1 commit into
python:mainfrom
zainnadeem786:docs/clarify-py-v-slashes

Conversation

@zainnadeem786

Copy link
Copy Markdown
Contributor

Summary

Clarify that the py -V examples in the Windows documentation are illustrative.

This small documentation change helps reduce ambiguity around the examples while keeping the section tutorial-oriented, without describing the underlying parsing behavior or implementation details.

No runtime behavior is changed.

Close: gh-148488

@read-the-docs-community

Copy link
Copy Markdown

Documentation build overview

📚 cpython-previews | 🛠️ Build #33489875 | 📁 Comparing f391cab against main (aa533dc)

  🔍 Preview build  

3 files changed
± library/string.html
± using/windows.html
± whatsnew/changelog.html

@zooba

zooba commented Jul 9, 2026

Copy link
Copy Markdown
Member

It's almost certainly not enough of a change to satisfy @serhiy-storchaka, but it's a PR right in front of us, so I'm inclined to merge it.

Serhiy, want to make any suggestions? Would this clarification have helped make it clearer?

@zooba zooba added needs backport to 3.14 bugs and security fixes needs backport to 3.15 pre-release feature fixes, bugs and security fixes labels Jul 9, 2026
@serhiy-storchaka

Copy link
Copy Markdown
Member

Sorry, it does not satisfy me. I created separate PR #153427.

@zainnadeem786

Copy link
Copy Markdown
Contributor Author

Hi @serhiy-storchaka,

Thanks for the clarification and for proposing the updated wording.

If you think it would be helpful, I'm happy to update my PR to match your suggested wording.

@zooba

zooba commented Jul 9, 2026

Copy link
Copy Markdown
Member

If you think it would be helpful, I'm happy to update my PR to match your suggested wording.

There's no need for that, we've got two PRs now, so we'll iterate them both and commit the one that makes the most sense.

I just commented on Serhiy's PR and some factual inaccuracies that I don't want being written in this early introduction. I'm still a fan of "not saying too much" here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

awaiting review docs Documentation in the Doc dir needs backport to 3.14 bugs and security fixes needs backport to 3.15 pre-release feature fixes, bugs and security fixes skip news

Projects

Status: Todo

Development

Successfully merging this pull request may close these issues.

Confusing documentation for "py -V"

3 participants